Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

State execution documentation #439

Draft
wants to merge 6 commits into
base: develop
Choose a base branch
from
Draft

State execution documentation #439

wants to merge 6 commits into from

Conversation

lukestanley
Copy link
Member

@lukestanley lukestanley commented Jan 26, 2024

As part of the investigation of state reactivity problems #435, it's helpful to document exactly how our system works (#436).
I started commenting BlocksWorkflowComponent, and added "Compodoc" to help explore Angular component dependencies.

Given a simple Flow of a Mapping Block generating a random UUID, and a Debug Block, I uncommented the console.log's in the BlocksWorkflowComponent, and reviewed them to made this sequence diagram:

sequenceDiagram
    participant Init as Initialization
    participant PrepStep as Preparation Step
    participant MappingBlock as Mapping Block
    participant DebugBlock as Debug Block

    Init ->> PrepStep: Initialize blocks
    PrepStep -->> MappingBlock: Prepare model (modelNumber 2 with {})
    MappingBlock -->> DebugBlock: Generate and emit UUID (modelNumber 1)
    DebugBlock -->> PrepStep: Process and emit UUID (modelNumber 2)
    Note right of DebugBlock: Workflow completes after Debug Block processing
Loading

I'm not quite sure where to put this sort of thing yet, obviously we wouldn't want to loose it! It might end up along side the RST files that Read the Docs uses.
It's only part of my investigation and it's not easy to understand yet.

Copy link

vercel bot commented Jan 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kendraio-app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 14, 2024 9:56am

})
export class BlocksWorkflowComponent implements OnInit {
export class BlocksWorkflowComponent implements OnInit, OnChanges {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lukestanley what about trying DoCheck too here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants